v15.4.2

Compare Source

Patch Changes

• 0ab6c7f: Improve performance by using shallow compare on useOnChange by default

v15.4.1

Compare Source

v15.4.0

Compare Source

Minor Changes

• 961b67e: Bump algolia search to v5

  This also introduced changes to some APIs since algoliasearch v4 and v5 has many differences.

  Now we highly recommend to pass an index name to sync():

  import { algoliasearch } from 'algoliasearch';
  import { sync } from 'fumadocs-core/search/algolia';
  const client = algoliasearch('id', 'key');
  
  void sync(client, {
    indexName: 'document',
    documents: records,
  });

  For search client, pass them to searchOptions:

  'use client';
  
  import { liteClient } from 'algoliasearch/lite';
  import type { SharedProps } from 'fumadocs-ui/components/dialog/search';
  import SearchDialog from 'fumadocs-ui/components/dialog/search-algolia';
  
  const client = liteClient(appId, apiKey);
  
  export default function CustomSearchDialog(props: SharedProps) {
    return (
      <SearchDialog
        searchOptions={{
          client,
          indexName: 'document',
        }}
        {...props}
        showAlgolia
      />
    );
  }

Patch Changes

• 1b999eb: Introduce <Markdown /> component
• 7d78bc5: Improve createRelativeLink and getPageByHref for i18n usage

v15.3.4

Compare Source

v15.3.3

Compare Source

Patch Changes

• 4ae7b4a: Support MDX in codeblock tab value

v15.3.2

Compare Source

Patch Changes

• c25d678: Support Shiki focus notation transformer by default

v15.3.1

Compare Source

Patch Changes

• 3372792: Support line numbers in codeblock

v15.3.0

Compare Source

Patch Changes

• c05dc03: Improve error message of remark image

v15.2.15

Compare Source

Patch Changes

• 50db874: Remove placeholder space for codeblocks
• 79e75c3: Improve default MDX attribute indexing strategy for remarkStructure

v15.2.14

Compare Source

Patch Changes

• 6ea1718: Fix type inference for pageTree.attachFile in loader()

v15.2.13

Compare Source

v15.2.12

Compare Source

Patch Changes

• acff667: Deprecate createFromSource(source, pageToIndex, options)

  Migrate:

  import { source } from '@​/lib/source';
  import { createFromSource } from 'fumadocs-core/search/server';
  
  // from
  export const { GET } = createFromSource(
    source,
    (page) => ({
      title: page.data.title,
      description: page.data.description,
      url: page.url,
      id: page.url,
      structuredData: page.data.structuredData,
      // use your desired value, like page.slugs[0]
      tag: '<value>',
    }),
    {
      // options
    },
  );
  
  // to
  export const { GET } = createFromSource(source, {
    buildIndex(page) {
      return {
        title: page.data.title,
        description: page.data.description,
        url: page.url,
        id: page.url,
        structuredData: page.data.structuredData,
        // use your desired value, like page.slugs[0]
        tag: '<value>',
      };
    },
    // other options
  });

v15.2.11

Compare Source

Patch Changes

• 07cd690: Support separators without name

v15.2.10

Compare Source

v15.2.9

Compare Source

v15.2.8

Compare Source

v15.2.7

Compare Source

Patch Changes

• ec85a6c: support more options on remarkStructure
• e1a61bf: Support remarkSteps plugin

v15.2.6

Compare Source

Patch Changes

• d49f9ae: Fix order of <I18nProvider />
• b07e98c: fix loader().getNodePage() returning undefined for other locales
• 3a4bd88: Fix wrong index files output in i18n page tree generation

v15.2.5

Compare Source

Patch Changes

• c66ed79: Fix removeScrollOn on sidebar primitive

v15.2.4

Compare Source

Patch Changes

• 1057957: Fix type problems on dynamic codeblock

v15.2.3

Compare Source

v15.2.2

Compare Source

Patch Changes

• 0829544: deprecate blockScrollingWidth in favour of removeScrollOn

v15.2.1

Compare Source

v15.2.0

Compare Source

Minor Changes

• 2fd325c: Enable lazy on rehypeCode by default
• a7cf4fa: Support other frameworks via FrameworkProvider

v15.1.3

Compare Source

Patch Changes

• b734f92: support mdxJsxFlowElement in remarkStructure

v15.1.2

Compare Source

Patch Changes

• 3f580c4: Support directory-based i18n routing

v15.1.1

Compare Source

Patch Changes

• c5add28: use internal store for Shiki highlighter instances
• f3cde4f: Support markdown files with default local code in file name
• 7c8a690: Improve file info interface
• b812457: Remove Next.js usage from search server

v15.1.0

Compare Source

Minor Changes

• f491f6f: Lazy build page tree by default
• f491f6f: Support getPageByHref() on loader API

Patch Changes

• f491f6f: Fix findNeighbour() doesn't exclude other nodes of another root

v15.0.18

Compare Source

v15.0.17

Compare Source

Patch Changes

• 72f79cf: Support Orama Cloud crawler index

v15.0.16

Compare Source

v15.0.15

Compare Source

Patch Changes

• 9f6d39a: Fix peer deps
• 2035cb1: remove hook-level cache from useDocsSearch()

v15.0.14

Compare Source

Patch Changes

• 37dc0a6: Update image-size to v2
• 796cc5e: Upgrade to Orama v3
• 2cc0be5: Support to add custom serialization to remarkStructure via data._string

v15.0.13

Compare Source

v15.0.12

Compare Source

Patch Changes

• 3534a10: Move fumadocs-core highlighting utils to fumadocs-core/highlight and fumadocs-core/highlight/client
• 93952db: Generate a $id attribute to page tree nodes